Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.
Setup code
To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:
library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)
plotly_widget <- plot_ly(x = diamonds$cut) %>%
config(displayModeBar = FALSE) %>%
layout(margin = list(t = 0, b = 0, l = 0, r = 0))
leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
leaflet(options = .) %>%
addTiles()Shiny usage
Cards work equally well in Shiny. In the
examples below, replace plotly_widget with
plotlyOutput() and leaflet_widget with
leafletOutput() to adapt them for Shiny server-rendered
plots/maps.
Hello card()
A card() is designed to handle any number of “known”
card items (e.g., card_header(), card_body(),
etc) as unnamed arguments (i.e., children). As we’ll see shortly,
card() also has some useful named arguments (e.g.,
full_screen, height, etc).
At their core, card() and card items are just an HTML
div() with a special Bootstrap class, so you can use
Bootstrap’s utility classes to customize things like colors,
text, borders,
etc.
card(
card_header(
class = "bg-dark",
"A header"
),
card_body(
markdown("Some text with a [link](https://github.com)")
)
)Some text with a link
Implicit card_body()
If you find yourself using card_body() without changing
any of its defaults, consider dropping it altogether since any direct
children of card() that aren’t “known” card()
items, are wrapped together into an implicit card_body()
call.1
For example, the code to the right generates HTML that is identical to
the previous example:
card(
card_header(
class = "bg-dark",
"A header"
),
markdown("Some text with a [link](https://github.com).")
)Some text with a link.
Restricting growth
By default, a card()’s size grows to accommodate the
size of it’s contents. Thus, if a card_body() contains a
large amount of text, tables, etc., you may want to specify a
height or max_height. That said, when laying
out multiple cards, it’s likely best not
to specify height on the card(), and instead, let the
layout determine the height layout_column_wrap().
Although scrolling is convenient for reducing the amount of space
required to park lots of content, it can also be a nuisance to the user.
To help reduce the need for scrolling, consider pairing scrolling with
full_screen = TRUE (which adds an icon to expand the card’s
size to the browser window). Notice how, when the card is expanded to
full-screen, max_height/height won’t effect
the full-screen size of the card.
card(
max_height = 250,
full_screen = TRUE,
card_header(
"A long, scrolling, description"
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Sit hac id turpis lacus feugiat nisi lobortis phasellus? Rutrum molestie, metus vivamus per metus ante justo ac erat accumsan. Nibh nostra fringilla, consequat eros per id suscipit luctus natoque fringilla: aptent suspendisse blandit. Magnis malesuada himenaeos pellentesque imperdiet rhoncus luctus feugiat nisl non! Sollicitudin augue semper.
Adipiscing parturient at tellus ultrices mattis; iaculis quisque est cursus mattis condimentum. Dictumst tempus erat facilisi malesuada tempus, orci, vulputate facilisi faucibus, placerat dis? Felis magna aliquam vel. Varius nisi enim orci feugiat placerat per sodales fusce ultrices nascetur vivamus vitae. Arcu netus mollis curabitur, ante placerat, fames orci elementum nibh elementum mollis himenaeos hendrerit ridiculus?
Consectetur dapibus, dapibus tempus natoque fames fusce mus primis. Torquent scelerisque congue habitasse pharetra nulla, aenean in class ut tempor torquent. Ad magnis tortor, blandit ridiculus parturient! Eget convallis auctor dapibus imperdiet sed egestas sagittis velit dis auctor conubia. Suscipit rutrum fames sed: dignissim imperdiet proin.
Filling outputs
A card()’s default behavior is optimized for
facilitating filling layouts. More
specifically, if a fill item (e.g.,
plotly_widget), appears as a direct child of a
card_body(), it resizes to fit the card()s
specified height. This means, by specifying height = 250
we’ve effectively shrunk the plot’s height from its default of 400 down
to about 200 pixels. And, when expanded to full_screen, the
plot grows to match the card()’s new size.
card(
height = 250,
full_screen = TRUE,
card_header("A filling plot"),
card_body(plotly_widget)
)Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny
output bindings (e.g, plotOutput(),
imageOutput(), etc) are fill items by
default, so this behavior “just works” in those scenarios. And, in some
of these situations, it’s helpful to remove card_body()’s
padding, which can be done via spacing
& alignment utility classes.
card(
height = 275,
full_screen = TRUE,
card_header("A filling map"),
card_body(
class = "p-0",
leaflet_widget
),
card_footer(
class = "fs-6",
"Copyright 2023 RStudio, PBC"
)
)Fill item(s) aren’t limited in how much they grow
and shrink, which can be problematic when a card becomes very small. To
work around this, consider adding a min_height on the
card_body() container. For example, try using the handle on
the lower-right portion of this card example to make the card
taller/smaller.
This interactive example is a bit contrived in that we’re using CSS
resize to demonstrate how to make plots that don’t shrink beyond a
certain point, but this concept becomes quite useful when implementing
page-level filling layouts (i.e.,
page_fillable()) with multiple
cards.
card(
height = 300,
style = "resize:vertical;",
card_header("Plots that grow but don't shrink"),
card_body(
min_height = 250,
plotly_widget,
plotly_widget
)
)Troubleshooting fill
As you’ll learn more about in filling
layouts, a fill item loses its ability to fill when
wrapped in additional UI element that isn’t a fillable
container. To fix the situation, use as_fill_carrier() to
allow the additional element to carry the potential to fill from the
card_body() down to the fill item.
Multiple card_body()
A card() can have multiple card_body()s,
which is especially useful for:
- Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
- Allowing each
card_body()to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g.,min_height).
For example, when pairing filling output with scrolling content, you
may want min_height on the filling output since the
scrolling content will force it to shrink:
card(
height = 375,
full_screen = TRUE,
card_header(
"Filling plot, scrolling description"
),
card_body(
min_height = 200,
plotly_widget
),
card_body(
class = "lead container",
lorem::ipsum(paragraphs = 10, sentences = 5)
)
)Adipiscing senectus sollicitudin felis nam donec non. Lectus risus blandit in, arcu laoreet odio. Purus massa consequat, sagittis dictum netus sociis placerat urna nunc. Parturient ultrices curabitur tortor nulla, netus aliquam vestibulum imperdiet sollicitudin – fermentum dui! Natoque leo per conubia aptent sollicitudin sociis aenean dignissim vulputate nisl sociis, magnis cubilia morbi, orci tincidunt odio nam varius metus!
Lorem congue tempor: egestas etiam sed praesent laoreet taciti suspendisse odio? Ut sapien feugiat, imperdiet per cras lectus vel consequat a neque mollis maecenas a? Nunc dis mi eget torquent et accumsan ridiculus tristique tempor cum. Fames dis morbi sociosqu commodo, nascetur in tristique dis. Posuere augue class diam maecenas elementum integer, nunc dapibus elementum tortor etiam, aliquam sociosqu aliquet leo natoque.
Consectetur taciti, id mus eu et suspendisse sapien. Cubilia sapien odio tempus imperdiet a lobortis, libero, interdum integer consequat blandit non. Fames lacus vehicula molestie massa proin facilisi ultrices orci nascetur laoreet! Feugiat malesuada donec nulla, class porttitor, massa metus faucibus ultricies. Sagittis dis non duis.
Dolor suscipit hendrerit praesent felis vel pretium varius leo facilisi. Mauris mi per purus venenatis nisl ac cras, litora nulla commodo fames. Laoreet platea morbi senectus quam dictum – himenaeos metus pharetra, ornare quam magnis. Sapien magnis volutpat, lectus interdum sociis purus conubia tellus. Mattis urna ultrices.
Amet augue sem himenaeos nostra, est habitasse curae dapibus luctus rutrum. Maecenas vitae urna ultrices ac venenatis aliquet pellentesque convallis diam primis egestas primis tortor. Cum pharetra magnis, tellus pretium purus porta porta dignissim massa. Volutpat platea, risus fusce quis vel mollis pretium cursus! Et dui euismod placerat mi.
Elit nisi ultricies venenatis diam! Ad tortor risus posuere accumsan magnis vitae molestie augue ornare semper conubia? Ultricies facilisi imperdiet malesuada lacinia; quisque diam. Facilisis mattis bibendum potenti? Orci aenean conubia lacus rutrum senectus hendrerit commodo massa fames posuere platea quam suscipit fringilla, fames curabitur sollicitudin!
Dolor lectus hendrerit lobortis neque sagittis eros: eleifend metus vehicula nullam neque neque? A massa convallis nisl eget ligula aenean elementum. Odio mollis; interdum lacinia mollis molestie nec, torquent est nostra. Primis tempor morbi vehicula nulla risus litora, integer proin nisl viverra morbi platea. Scelerisque dapibus senectus ac tortor at facilisis.
Amet tellus dis ullamcorper, ultrices laoreet vehicula mus tellus. Non ad placerat vehicula dis, est leo vehicula quisque morbi. Lobortis ultrices senectus, libero habitasse, molestie scelerisque mollis? Mi enim nam, lobortis habitasse molestie est leo per proin arcu. Euismod condimentum luctus cursus turpis dictum, venenatis facilisi et tincidunt hendrerit rhoncus ligula hac aliquet.
Sit sollicitudin arcu blandit auctor eu metus eros erat. Enim nulla est erat fringilla; class est sed, interdum sodales? Eleifend mauris sollicitudin: ridiculus, tempor, eleifend a, primis libero torquent parturient? Montes inceptos ante, dictumst libero ornare maecenas dui. Vestibulum faucibus eget mi eros turpis dictum cras hac natoque auctor.
Amet ligula nostra at nec in; tempor nunc platea. Ad sed nostra sodales ac auctor pulvinar ultricies himenaeos dictumst curae morbi integer. Dignissim luctus ultrices luctus ultricies eu curabitur et curabitur iaculis. Dictumst vulputate enim laoreet sociosqu taciti. Pellentesque scelerisque leo luctus parturient odio, facilisi laoreet quis?
Also, when the content has a fixed size, and should not be allowed to
scroll, set fill = FALSE:
card(
height = 350,
full_screen = TRUE,
card_header(
"Filling plot, short description"
),
plotly_widget,
card_body(
fill = FALSE,
card_title("A subtitle"),
p(class = "text-muted", "And a caption")
)
)A subtitle
And a caption
Multiple columns
As you’ll learn in column-based
layouts, layout_column_wrap() is great for multi-column
layouts that are responsive and accommodate for filling output. Here we have an equal-width
2-column layout using width = 1/2, but it’s also possible
to have varying column
widths.
card(
height = 350,
full_screen = TRUE,
card_header("A multi-column filling layout"),
card_body(
min_height = 200,
layout_column_wrap(
width = 1/2,
plotOutput("p1"),
plotOutput("p2")
)
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Dolor non sodales himenaeos felis himenaeos purus fringilla faucibus semper tristique nascetur, etiam a fermentum. Tincidunt lobortis aliquam, sagittis, leo nullam blandit eleifend, fusce nisl? Imperdiet senectus interdum: sed in libero primis senectus porta bibendum. Feugiat erat aliquam habitant: luctus velit praesent gravida lacinia dictumst. Pulvinar nunc id nec nibh velit curabitur curabitur bibendum magna magnis.
Amet porttitor volutpat sociis ante facilisi pretium viverra. Primis elementum sagittis mi tempus eros turpis ridiculus; eros parturient accumsan sociosqu natoque pulvinar. Imperdiet magna fermentum odio montes iaculis sagittis, quis inceptos proin massa pharetra! Ridiculus placerat sapien lectus quam pretium velit purus! Augue mauris arcu condimentum dictumst – quisque cras litora quisque a morbi.
Dolor netus, aliquet; ultricies aenean litora. Tellus odio luctus iaculis maecenas vel facilisi platea euismod donec scelerisque! Risus ullamcorper dui libero facilisi non tincidunt gravida? In mus augue venenatis natoque hac, interdum odio leo faucibus. Massa nibh sapien feugiat bibendum turpis risus auctor maecenas fringilla aliquam morbi nam augue, arcu elementum nascetur fusce id vel aenean aenean netus duis.
Multiple cards
layout_column_wrap() is especially nice for laying out
multiple cards since each card in a particular row will have the same
height (by default). Learn more in column-based layouts.
layout_column_wrap(
width = 1/2,
height = 300,
card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)Multiple tabs
navset_card_tab() and navset_card_pill()
make it possible to create cards with multiple tabs or pills. These
functions have the same full_screen capabilities as normal
card()s as well some other options like title
(since there is no natural place for a card_header() to be
used). Note that, each nav_panel() object is similar to a
card(). That is, if the direct children aren’t already card
items (e.g., card_title()), they get implicitly wrapped in a
card_body().
library(leaflet)
navset_card_tab(
height = 450,
full_screen = TRUE,
title = "HTML Widgets",
nav_panel(
"Plotly",
card_title("A plotly plot"),
plotly_widget
),
nav_panel(
"Leaflet",
card_title("A leaflet plot"),
leaflet_widget
),
nav_panel(
shiny::icon("circle-info"),
markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
)
)Sidebars
As you’ll learn more about in sidebar
layouts, layout_sidebar() just works when placed inside
in a card(). In this case, if you want fill
items (e.g., plotly_widget) to still fill the card
like we’ve seen before, you’ll need to
set fillable = TRUE in layout_sidebar().
card(
height = 300,
full_screen = TRUE,
card_header("A sidebar layout inside a card"),
layout_sidebar(
fillable = TRUE,
sidebar = sidebar(
actionButton("btn", "A button")
),
plotly_widget
)
)Static images
card_image() makes it easy to embed static (i.e.,
pre-generated) images into a card. Provide a URL to href to
make it clickable. In the case of multiple card_image()s,
consider laying them out in multiple cards
with layout_column_wrap() to produce a grid of clickable
thumbnails.
card(
height = 300,
full_screen = TRUE,
card_image(
file = "shiny-hex.svg",
href = "https://github.com/rstudio/shiny"
),
card_body(
fill = FALSE,
card_title("Shiny for R"),
p(
class = "fw-light text-muted",
"Brought to you by RStudio."
)
)
)
Shiny for R
Brought to you by RStudio.
Flexbox
Both card() and card_body() default to
fillable = TRUE (that is, they are CSS flexbox
containers), which works wonders for facilitating filling outputs, but it also leads to
surprising behavior with inline tags (e.g., actionButton(),
span(), strings, etc). Specifically, each inline tag is
placed on a new line, but in a “normal” layout flow
(fillable = FALSE), inline tags render inline.
card(
card_body(
fillable = TRUE,
"Here's some", tags$i("inline"), "text",
actionButton("btn1", "A button")
),
card_body(
fillable = FALSE,
"Here's some", tags$i("inline"), "text",
actionButton("btn2", "A button")
)
)That said, sometimes working in a flexbox layout is quite useful,
even when working with inline tags. Here we leverage flexbox’s gap
property to control the spacing between a plot, a (full-width) button,
and paragraph. Note that, by using markdown() for the
paragraph, it wraps the results in a <p> tag, which
means the contents of the paragraph are not longer subject to
flexbox layout. If we wanted, we could do something similar to render
the actionButton() inline by wrapping it in a
div().
card(
height = 325, full_screen = TRUE,
card_header("A plot with an action links"),
card_body(
class = "gap-2 container",
plotly_widget,
actionButton(
"go_btn", "Action button",
class = "btn-primary rounded-0"
),
markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
)
)Here's a simple hyperlink.
In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.
card(
height = 300, full_screen = TRUE,
card_header(
class = "d-flex justify-content-between",
"Centered plot",
checkboxInput("check", " Check me", TRUE)
),
card_body(
class = "align-items-center",
plotOutput("id", width = "75%")
)
)Shiny
Since this article is statically rendered, the examples here use
statically rendered content/widgets, but the same card()
functionality works for dynamically rendered content via Shiny (e.g.,
plotOutput(), plotlyOutput(), etc).
An additional benefit that comes with using shiny is the ability to
use getCurrentOutputInfo() to render new/different content
when the output container becomes large enough, which is particularly
useful with card(full_screen = T, ...). For example, you
may want additional captions/labels when a plot is large, additional
controls on a table, etc (see the value
boxes article for a clever use of this).
# UI logic
ui <- page_fluid(
card(
max_height = 200,
full_screen = TRUE,
card_header("A dynamically rendered plot"),
plotOutput("plot_id")
)
)
# Server logic
server <- function(input, output, session) {
output$plot_id <- renderPlot({
info <- getCurrentOutputInfo()
if (info$height() > 600) {
# code for "large" plot
} else {
# code for "small" plot
}
})
}
shinyApp(ui, server)Appendix
The following CSS is used to give plotOutput() a
background color; it’s necessary here because this documentation page is
not actually hooked up to a Shiny app, so we can’t show a real plot.